<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Parse a YAML stream</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="function.yaml-parse-url.html">« yaml_parse_url</a></li>
      <li style="float: right;"><a href="book.yaf.html">Yaf »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="ref.yaml.html">Yaml 函数</a></li>
    <li>Parse a YAML stream</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="function.yaml-parse" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaml_parse</h1>
  <p class="verinfo">(PECL yaml &gt;= 0.4.0)</p><p class="refpurpose"><span class="refname">yaml_parse</span> &mdash; <span class="dc-title">Parse a YAML stream</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.yaml-parse-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>yaml_parse</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">string</span> <code class="parameter">$input</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">int</span> <code class="parameter">$pos</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$ndocs</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">array</span> <code class="parameter">$callbacks</code><span class="initializer"> = <strong><code>null</code></strong></span></span><br>): <span class="type"><a href="language.types.declarations.html#language.types.declarations.mixed" class="type mixed">mixed</a></span></div>

  <p class="para rdfs-comment">
   Convert all or part of a YAML document stream to a PHP variable.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.yaml-parse-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt>
<code class="parameter">input</code></dt>

     <dd>

      <p class="para">
       The <span class="type">string</span> to parse as a YAML document stream.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">pos</code></dt>

     <dd>

      <p class="para">
       Document to extract from stream (<code class="literal">-1</code> for all
       documents, <code class="literal">0</code> for first document, ...).
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">ndocs</code></dt>

     <dd>

      <p class="para">
       If <code class="parameter">ndocs</code> is provided, then it is filled with the
       number of documents found in stream.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">callbacks</code></dt>

     <dd>

      <p class="para">
       Content handlers for YAML nodes. Associative <span class="type">array</span> of YAML
       tag =&gt; <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> mappings. See
       <a href="yaml.callbacks.parse.html" class="link">parse callbacks</a> for more
       details.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.yaml-parse-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns the value encoded in <code class="parameter">input</code> in appropriate
   PHP type 或者在失败时返回 <strong><code>false</code></strong>. If <code class="parameter">pos</code> is <code class="literal">-1</code> an
   <span class="type">array</span> will be returned with one entry for each document found
   in the stream.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.yaml-parse-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-3857">
    <p><strong>示例 #1 <span class="function"><strong>yaml_parse()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$yaml&nbsp;</span><span style="color: #007700">=&nbsp;&lt;&lt;&lt;EOD<br /></span><span style="color: #DD0000">---<br />invoice:&nbsp;34843<br />date:&nbsp;"2001-01-23"<br />bill-to:&nbsp;&amp;id001<br />&nbsp;&nbsp;given:&nbsp;Chris<br />&nbsp;&nbsp;family:&nbsp;Dumars<br />&nbsp;&nbsp;address:<br />&nbsp;&nbsp;&nbsp;&nbsp;lines:&nbsp;|-<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;458&nbsp;Walkman&nbsp;Dr.<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Suite&nbsp;#292<br />&nbsp;&nbsp;&nbsp;&nbsp;city:&nbsp;Royal&nbsp;Oak<br />&nbsp;&nbsp;&nbsp;&nbsp;state:&nbsp;MI<br />&nbsp;&nbsp;&nbsp;&nbsp;postal:&nbsp;48046<br />ship-to:&nbsp;*id001<br />product:<br />-&nbsp;sku:&nbsp;BL394D<br />&nbsp;&nbsp;quantity:&nbsp;4<br />&nbsp;&nbsp;description:&nbsp;Basketball<br />&nbsp;&nbsp;price:&nbsp;450<br />-&nbsp;sku:&nbsp;BL4438H<br />&nbsp;&nbsp;quantity:&nbsp;1<br />&nbsp;&nbsp;description:&nbsp;Super&nbsp;Hoop<br />&nbsp;&nbsp;price:&nbsp;2392<br />tax:&nbsp;251.420000<br />total:&nbsp;4443.520000<br />comments:&nbsp;Late&nbsp;afternoon&nbsp;is&nbsp;best.&nbsp;Backup&nbsp;contact&nbsp;is&nbsp;Nancy&nbsp;Billsmer&nbsp;@&nbsp;338-4338.<br />...<br /></span><span style="color: #007700">EOD;<br /><br /></span><span style="color: #0000BB">$parsed&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">yaml_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$yaml</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$parsed</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents"><p>以上例程的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
array(8) {
  [&quot;invoice&quot;]=&gt;
  int(34843)
  [&quot;date&quot;]=&gt;
  string(10) &quot;2001-01-23&quot;
  [&quot;bill-to&quot;]=&gt;
  &amp;array(3) {
    [&quot;given&quot;]=&gt;
    string(5) &quot;Chris&quot;
    [&quot;family&quot;]=&gt;
    string(6) &quot;Dumars&quot;
    [&quot;address&quot;]=&gt;
    array(4) {
      [&quot;lines&quot;]=&gt;
      string(34) &quot;458 Walkman Dr.
        Suite #292&quot;
      [&quot;city&quot;]=&gt;
      string(9) &quot;Royal Oak&quot;
      [&quot;state&quot;]=&gt;
      string(2) &quot;MI&quot;
      [&quot;postal&quot;]=&gt;
      int(48046)
    }
  }
  [&quot;ship-to&quot;]=&gt;
  &amp;array(3) {
    [&quot;given&quot;]=&gt;
    string(5) &quot;Chris&quot;
    [&quot;family&quot;]=&gt;
    string(6) &quot;Dumars&quot;
    [&quot;address&quot;]=&gt;
    array(4) {
      [&quot;lines&quot;]=&gt;
      string(34) &quot;458 Walkman Dr.
        Suite #292&quot;
      [&quot;city&quot;]=&gt;
      string(9) &quot;Royal Oak&quot;
      [&quot;state&quot;]=&gt;
      string(2) &quot;MI&quot;
      [&quot;postal&quot;]=&gt;
      int(48046)
    }
  }
  [&quot;product&quot;]=&gt;
  array(2) {
    [0]=&gt;
    array(4) {
      [&quot;sku&quot;]=&gt;
      string(6) &quot;BL394D&quot;
      [&quot;quantity&quot;]=&gt;
      int(4)
      [&quot;description&quot;]=&gt;
      string(10) &quot;Basketball&quot;
      [&quot;price&quot;]=&gt;
      int(450)
    }
    [1]=&gt;
    array(4) {
      [&quot;sku&quot;]=&gt;
      string(7) &quot;BL4438H&quot;
      [&quot;quantity&quot;]=&gt;
      int(1)
      [&quot;description&quot;]=&gt;
      string(10) &quot;Super Hoop&quot;
      [&quot;price&quot;]=&gt;
      int(2392)
    }
  }
  [&quot;tax&quot;]=&gt;
  float(251.42)
  [&quot;total&quot;]=&gt;
  float(4443.52)
  [&quot;comments&quot;]=&gt;
  string(68) &quot;Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.&quot;
}
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.yaml-parse-notes">
  <h3 class="title">注释</h3>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
    Processing untrusted user input with <span class="function"><strong>yaml_parse()</strong></span>
    is dangerous if the use of <span class="function"><a href="function.unserialize.html" class="function">unserialize()</a></span> is enabled for
    nodes using the <code class="literal">!php/object</code> tag. This behavior can be
    disabled by using the <code class="literal">yaml.decode_php</code> ini setting.
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.yaml-parse-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="function.yaml-parse-file.html" class="function" rel="rdfs-seeAlso">yaml_parse_file()</a> - Parse a YAML stream from a file</span></li>
    <li class="member"><span class="function"><a href="function.yaml-parse-url.html" class="function" rel="rdfs-seeAlso">yaml_parse_url()</a> - Parse a Yaml stream from a URL</span></li>
    <li class="member"><span class="function"><a href="function.yaml-emit.html" class="function" rel="rdfs-seeAlso">yaml_emit()</a> - Returns the YAML representation of a value</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>